Development guides

Centre de Notification : publier une alerte

Inviter le compte bot

Le compte bot doit être invité dans les salles où vous souhaitez que les notifications soient envoyées. Une fois cela fait, il acceptera automatiquement et rejoindra le canal.

Écrire des Notifications

Les notifications doivent être envoyées à un jetstream nats sous forme de JSON STRING (pas avro ou autres formats spécifiques). Les en-têtes Nats ne sont pas actuellement utilisés. Si le flux n'est pas encore créé lorsque le notificateur initialise, il sera créé, sinon il sera mis à jour pour correspondre à la configuration du client notificateur.

Il y a actuellement deux champs supportés dans les notifications JSON :

• roomAlias : ce champ doit contenir soit l'ID unique de la salle soit son alias
  • Les alias sont sous le format : #<alias>:<nom-du-serveur-matrix>
  • Les ID uniques sont sous le format : !<id>:<nom-du-serveur-matrix>
• message : cela contient la notification que vous souhaitez envoyer.
  • Les mentions sont supportées, mais vous devez donner au compte bot les permissions d'utiliser les mentions dans le canal pour que cela fonctionne.

Comme les notifications doivent passer par jetstream nats, vous devrez respecter la taille maximale de message configurée. (par défaut : 1 Mo)

Exemples de Notifications

En utilisant l'alias de salle lisible par l'homme (commence par #) :

{
    "roomAlias": "#test1:kosmos-matrix",
    "message": "ceci est un message de test envoyé à une salle par alias pour l'utilisateur @atheaadmin:kosmos-matrix"
}

En utilisant directement l'ID de la salle (commence par !) :

{
    "roomAlias": "!cegqmHkBxkhGiOjvIW:kosmos-matrix",
    "message": "ceci est un message de test envoyé à une salle par ID avec mention générale @here"
}

info

Pour obtenir l'ID de la salle, cliquez sur les 3 points à côté du nom d'un canal (Options de la salle), puis Paramètres et enfin allez dans l'onglet Avancé. L'ID peut être copié/collé depuis le champ ID de salle interne.